Standardise admonitions (#1382) #1383
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Most admonitions are either [NOTE], [TIP], [IMPORTANT]. This tries to standardise their use, using the following guidelines: [NOTE]: Use for general information or observations that are helpful but not critical. [TIP]: Use for optional advice, shortcuts, or suggestions that enhance understanding or efficiency. [IMPORTANT]: Use for essential information that the reader must follow to avoid mistakes or problems.
JPryce-Aklundh
added
cherry-picked
Collaborator
|
Thanks for the documentation updates. The preview documentation has now been torn down - reopening this PR will republish it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Most admonitions are either [NOTE], [TIP], [IMPORTANT]. This tries to standardise their use, using the following guidelines:
[NOTE]: Use for general information or observations that are helpful but not critical.
[TIP]: Use for optional advice, shortcuts, or suggestions that enhance understanding or efficiency.
[IMPORTANT]: Use for essential information that the reader must follow to avoid mistakes or problems.